<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>DB_TXN-&gt;set_commit_token()</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
    <link rel="up" href="rep.html" title="Chapter 10.  Replication Methods" />
    <link rel="prev" href="envtxn_applied.html" title="DB_ENV-&gt;txn_applied()" />
    <link rel="next" href="seq.html" title="Chapter 11.  The DB_SEQUENCE Handle" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 12.1.6.2</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_TXN-&gt;set_commit_token()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="envtxn_applied.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 10. 
                Replication Methods
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="seq.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="txnset_commit_token"></a>DB_TXN-&gt;set_commit_token()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_TXN-&gt;set_commit_token(DB_TXN *txn, DB_TXN_TOKEN *buffer);  </pre>
      <p>
        The <code class="methodname">DB_TXN-&gt;set_commit_token()</code> method
        configures the transaction for commit token generation, and accepts
        the address of an application-supplied buffer to receive the token.
        The actual generation of the token contents does not occur until
        commit time.
    </p>
      <p>
        Commit tokens are used to enable some consistency guarantees for
        replicated applications. Please see the 
        <a href="../../programmer_reference/rep_ryw.html" class="olink">Read your writes consistency</a>
        section in the <em class="citetitle">Berkeley DB Programmer's Reference Guide</em>
        for more information.
    </p>
      <p>
        The <code class="methodname">DB_TXN-&gt;set_commit_token()</code> method may be 
        called at any time after the 
        <a class="xref" href="txnbegin.html" title="DB_ENV-&gt;txn_begin()">DB_ENV-&gt;txn_begin()</a>
        method has been called, and before
        <a class="xref" href="txncommit.html" title="DB_TXN-&gt;commit()">DB_TXN-&gt;commit()</a>
        has been called.
    </p>
      <p>
        The <code class="methodname">DB_TXN-&gt;set_commit_token()</code> <span>
            <span>
                  method returns a non-zero error value on failure and 0 on success.
            </span>
            
        </span>
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711172789456"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idm140711172824944"></a>buffer</h4>
              </div>
            </div>
          </div>
          <p>
                 The address of an application-supplied buffer.
                 The buffer memory must remain available, and will
                 be filled in later by Berkeley DB, at the time of
                 the commit() call.
             </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711172790352"></a>Errors</h3>
            </div>
          </div>
        </div>
        <p>
             The <code class="methodname">DB_TXN-&gt;set_commit_token()</code> <span>
            <span>
                 method may fail and return one of the following non-zero errors:
            </span>
            
        </span>
        </p>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idm140711172779536"></a>EINVAL</h4>
              </div>
            </div>
          </div>
          <p>
                If the transaction is a nested transaction; if
                this method is called on a replication client;
                if the database environment is not configured
                for logging.
            </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711172772928"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
                 <a class="link" href="txn.html" title="Chapter 12.  The DB_TXN Handle">DB_TXN</a> 
            </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idm140711172845376"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
                    <a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a>,
                    <a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>
                </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="envtxn_applied.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="rep.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="seq.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_ENV-&gt;txn_applied() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Chapter 11. 
                The DB_SEQUENCE Handle 
        </td>
        </tr>
      </table>
    </div>
  </body>
</html>
